home *** CD-ROM | disk | FTP | other *** search
/ Apple Technical Information Source 1992 September / Apple Tech I.S. 3.0 (Sept-1992).toast / Utilities / StuffIt & Frontier / DocServer Source Text next >
Encoding:
Text File  |  1992-07-01  |  93.3 KB  |  1,839 lines  |  [ttro/ttxt]

  1.  
  2. Verb    StuffIt.archive.getMaxCount
  3. Syntax    StuffIt.archive.getMaxCount ()
  4. Parameters    None
  5. Action    Gets the maximum number of archives which StuffIt can have open
  6. Returns    The number of archives which StuffIt can have open
  7. Examples    StuffIt.archive.getMaxCount ()
  8.     »8 (The maximum number of archives which StuffIt can have open with its default memory partition)
  9. See Also    StuffIt.archive.getOpenCount
  10.  
  11. Verb    StuffIt.archive.getOpenCount
  12. Syntax    StuffIt.archive.getOpenCount ()
  13. Parameters    None
  14. Action    Gets the number of open archives.
  15. Returns    The number of archives which are currently open
  16. Examples    StuffIt.archive.getOpenCount ()
  17.     »1 (The number of archives which I currently have open)
  18. See Also    StuffIt.archive.getMaxCount
  19.  
  20. Verb    StuffIt.archive.getPath
  21. Syntax    StuffIt.archive.getPath (index)
  22. Parameters    index: the number of the archive you wish to get information for. The frontmost archive is 0, and all other archives are numbered sequentially from the front
  23. Action    Gets the full pathname of the archive you specify
  24. Returns    The full pathname of the archive specified by index
  25. Examples    StuffIt.archive.getPath (0)
  26.     »"My HD:My Folder:My Archive" (The pathname of the frontmost archive)
  27.  
  28. Verb    StuffIt.bringToFront
  29. Syntax    StuffIt.bringToFront ()
  30. Parameters    None
  31. Action    Brings StuffIt to the front, making it the active application.
  32. Returns    True if the event was successfully sent
  33. Examples    StuffIt.bringToFront ()
  34.     »true (and StuffIt is now the frontmost application)
  35.  
  36. Verb    StuffIt.closeAll
  37. Syntax    StuffIt.closeAll ()
  38. Parameters    None
  39. Action    Closes every open archive
  40. Returns    True if successful, false if no windows were open
  41. Examples    StuffIt.closeAll ()
  42.     »true (There was at least one open archive to close)
  43.  
  44. Verb    StuffIt.closeArchive
  45. Syntax    StuffIt.closeArchive (path)
  46. Parameters    path: the full pathname of the archive you wish to close
  47. Action    Closes the specified archive
  48. Returns    0 if there was no error
  49. 1 if the archive you specify was not open
  50. Examples    StuffIt.closeArchive ("My HD:My Folder:My Archive")
  51.     »0 (Archive was closed)
  52. See Also    openArchive
  53. closeAll
  54.  
  55. Verb    StuffIt.comment.delete
  56. Syntax    StuffIt.comment.delete ()
  57. Parameters    None
  58. Action    Deletes the comment attached to the frontmost archive
  59. Returns    True if the comment was deleted
  60. Examples    StuffIt.comment.delete ()
  61.     »true (comment was deleted)
  62. See Also    comment.get
  63. comment.set
  64. Notes    This verb will return true even if no comment was attached to the archive.
  65.  
  66. Verb    StuffIt.comment.get
  67. Syntax    StuffIt.comment.get ()
  68. Parameters    None
  69. Action    Gets the comment attached to the frontmost archive window
  70. Returns    The comment
  71. Examples    StuffIt.comment.get ()
  72.     »"Check out the 'Cool Things' Folder!" (the comment attached to the frontmost archive
  73. See Also    comment.delete
  74. comment.set
  75.  
  76. Verb    StuffIt.comment.set
  77. Syntax    StuffIt.comment.set (comment)
  78. Parameters    comment: the comment you would like to attach to the frontmost archive
  79. Action    Attaches the comment you specify to the frontmost archive
  80. Returns    True if the comment was successfully added
  81. Examples    StuffIt.comment.set ("Check out the 'Cool Things' Folder!")
  82.     »true (the comment was attached to the frontmost archive)
  83. See Also    comment.delete
  84. comment.get
  85. Notes    Setting the comment will overwrite any existing comment. You may wish to get the comment first, and then set it only if it's empty
  86.  
  87. Verb    StuffIt.deleteItem
  88. Syntax    StuffIt.deleteItem(ID)
  89. Parameters    ID: the offset of the item info within the archive. 0 is the archive itself, and you can determine all subsequent children by using getItemChild and getNextItem.
  90. Action    Deletes the specified iem, without a warning dialog box
  91. Returns    0 if there was no error
  92. -1 if no archive is open
  93. -8 if the archive is read-only
  94. Examples    StuffIt.deleteItem (StuffIt.getFirstItem())
  95.     »0 (deleted the first item in the archive)
  96. See Also    StuffIt.selection.delete
  97.  
  98. Verb    StuffIt.doScript
  99. Syntax    StuffIt.doScript (script)
  100. Parameters    script: either the text of the script you wish to execute, or a filename that points to a saved script
  101. Action    Executes the script you specify
  102. Returns    True if the script was executed
  103. Examples    StuffIt.doScript ("My HD:My Folder:My Script")
  104.     »true (the script was run)
  105.  
  106. Verb    StuffIt.encryptItem
  107. Syntax    StuffIt.encryptItem (path)
  108. Parameters    path: the pathname of the file or folder you'd like to stuff & encrypt into the current archive
  109. Action    Takes the folder/file you specify and adds it to the current level of the frontmost archive.
  110. Returns    0 if there was no error
  111. -1 if no archive is currently open
  112. -7 if there are already too many items in the archive
  113. -8 if the frontmost archive is read-only
  114. Examples    StuffIt.encryptItem ("My HD:My Folder:My File")
  115.     »0 (My File was added to the current level of the archive)
  116. See Also    StuffIt.password.set
  117. StuffIt.password.isSet
  118. StuffIt.stuffItem
  119. StuffIt.unstuffItem
  120.  
  121. Verb    StuffIt.getCurrentArchivePath
  122. Syntax    StuffIt.getCurrentArchivePath ()
  123. Parameters    None
  124. Action    Gets the full pathname of the frontmost archive
  125. Returns    The full pathname of the frontmost archive, or -1 if no archive is open.
  126. Examples    StuffIt.getCurrentArchivePath ()
  127.     »My HD:My Folder:My Archive (the pathname of the frontmost archive)
  128. See Also    StuffIt.archive.getPath
  129. StuffIt.setCurrentArchive
  130.  
  131. Verb    StuffIt.getCurrentFolder
  132. Syntax    StuffIt.getCurrentFolder()
  133. Parameters    None
  134. Action    Gets the offset number of the current folder.
  135. Returns    The offset number for the current folder
  136. -1 if no archive is open
  137. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  138. Examples    StuffIt.getCurrentFolder ()
  139.     »0 (we're at the top level of the archive)
  140. See Also    StuffIt.openFolder
  141.  
  142. Verb    StuffIt.getFirstItem
  143. Syntax    StuffIt.getFirstItem()
  144. Parameters    None
  145. Action    Gets the offset number of the first item within the current folder.
  146. Returns    The offset number for the first item in the current folder
  147. -1 if no archive is open
  148. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  149. 0 if there are no entries in this folder
  150. Examples    StuffIt.getFirstItem()
  151.     »22 (the offset of the first item within the archive)
  152. See Also    StuffIt.getNextItem
  153. StuffIt.getPreviousItem
  154.  
  155. Verb    StuffIt.getItemChild
  156. Syntax    StuffIt.getItemChild (ID)
  157. Parameters    ID: the offset of the item info within the archive. 0 is the archive itself, and you can determine all subsequent children by using getItemChild and getNextItem.
  158. Action    Gets the offset number of the first item within the folder you specify.
  159. Returns    The offset number for the first item in the specified folder
  160. -1 if no archive is open
  161. -2 if the offset you specify is not an acceptable range
  162. -3 if the item at the offset is not a folder or an archive
  163. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  164. 0 if there are no children of this item
  165. Any other negative number if the item you specify does not exist
  166. Examples    StuffIt.getItemChild (0)
  167.     »22 (the offset of the first item within the archive)
  168. See Also    StuffIt.getItemParent
  169. StuffIt.getFirstItem
  170. StuffIt.getNextItem
  171. StuffIt.getPreviousItem
  172. StuffIt.getItemCount
  173.  
  174. Verb    StuffIt.getItemCompressedSize
  175. Syntax    StuffIt.getItemCompressedSize(ID)
  176. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  177. Action    Gets the full size (compressed) of the item you specify with offset
  178. Returns    The compressed size of the file, folder, or archive in bytes
  179. -1 if no archive is open
  180. -2 if the offset you specify is not an acceptable range
  181. -5 if the item at the offset is the end of a folder
  182. Any other negative number if the item you specify does not exist
  183. Examples    StuffIt.getItemCompressedSize (StuffIt.getFirstItem())
  184.     »26345 (the full, uncompressed size of the first item)
  185. See Also    StuffIt.getItemSize
  186.  
  187. Verb    StuffIt.getItemCount
  188. Syntax    StuffIt.getItemCount (ID)
  189. Parameters    ID: the offset of the folder info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  190. Action    Gets the number of items in the item at the offset you specify
  191. Returns    The number of children in the specified item
  192. -1 if no archive is open
  193. -2 if the offset you specify is not an acceptable range
  194. -3 if the item at the offset is not a folder or an archive
  195. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  196. 0 if there are no children of this item
  197. Any other negative number if the item you specify does not exist
  198. Examples    StuffIt.getItemCount (0)
  199.     »3 (the number of items in the frontmost archive)
  200. See Also    StuffIt.getFirstItem
  201. StuffIt.getNextItem
  202. StuffIt.getPreviousItem
  203. StuffIt.getItemChild
  204.  
  205. Verb    StuffIt.getItemCreated
  206. Syntax    StuffIt.getItemCreated (ID)
  207. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  208. Action    Gets the creation date of the item specified by ID
  209. Returns    The creation date of the specified item
  210. -1 if no archive is open
  211. -2 if the offset you specify is not an acceptable range
  212. Any other negative number if the item you specify does not exist
  213. Examples    StuffIt.getItemCreated (0)
  214.     »3/21/92 (the date the archive was created)
  215. See Also    StuffIt.getItemModified
  216.  
  217. Verb    StuffIt.getItemCreator
  218. Syntax    StuffIt.getItemCreator (ID)
  219. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  220. Action    Gets the four-letter signature of the application which created this document
  221. Returns    The creator signature of the application which created the document
  222. -1 if no archive is open
  223. -2 if the offset you specify is not an acceptable range
  224. -5 if the item you specify is a folder or end of folder
  225. Any other negative number if the item you specify does not exist
  226. Examples    StuffIt.getItemCreator (0)
  227.     »"SIT!" (since the archive itself is at offset 0, the application which created it is StuffIt)
  228. See Also    StuffIt.getItemType
  229. StuffIt.getItemKind
  230.  
  231. Verb    StuffIt.getItemID
  232. Syntax    StuffIt.getItemID (index)
  233. Parameters    index: the index of the file at the current level whose ID (offset) you wish to get
  234. Action    Returns the offset of the item at the specified indexed location in the current folder
  235. Returns    offset of the item
  236. -1 if no archive is open
  237. -2 if the index you specify is not an acceptable range
  238. Any other negative number if the item you specify does not exist
  239. Examples    StuffIt.getItemID (1)
  240.     »22 (the offset of the first item)
  241. See Also    StuffIt.getFirstItem
  242. StuffIt.getNextItem
  243. StuffIt.getPreviousItem
  244. StuffIt.getItemChild
  245.  
  246. Verb    StuffIt.getItemKind
  247. Syntax    StuffIt.getItemKind (ID)
  248. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  249. Action    Returns a description about what kind of item is at the offset you specify
  250. Returns    archive, folder, file, or end-of-folder
  251. -1 if no archive is open
  252. -2 if the offset you specify is not an acceptable range
  253. Any other negative number if the item you specify does not exist
  254. Examples    StuffIt.getItemKind (0)
  255.     »archive (the item 0 represents the archive itself)
  256. See Also    getItemType
  257. getItemCreator
  258.  
  259. Verb    StuffIt.getItemModified
  260. Syntax    StuffIt.getItemModified (ID)
  261. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  262. Action    Gets the modified date of the item at offset ID
  263. Returns    The modified date of the file, folder, or archive
  264. -1 if no archive is open
  265. -2 if the offset you specify is not an acceptable range
  266. -5 if the item at the offset is the end of a folder
  267. Any other negative number if the item you specify does not exist
  268. Examples    StuffIt.getItemModified (0)
  269.     »3/21/92 (the last date that this archive was modified)
  270. See Also    getItemCreated
  271.  
  272. Verb    StuffIt.getItemName
  273. Syntax    StuffIt.getItemName (ID)
  274. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  275. Action    Gets the name of the item at offset ID
  276. Returns    The name of the file, folder, or archive
  277. -1 if no archive is open
  278. -2 if the offset you specify is not an acceptable range
  279. -5 if the item at the offset is the end of a folder
  280. Any other negative number if the item you specify does not exist
  281. Examples    StuffIt.getItemName (StuffIt.getFirstItem())
  282.     »Things to look at (the name of the first item)
  283. See Also    getItemType
  284. getItemCreator
  285. getItemKind
  286.  
  287. Verb    StuffIt.getItemParent
  288. Syntax    StuffIt.getItemParent(ID)
  289. Parameters    ID: the offset of the item info within the archive. 
  290. Action    Gets the offset number of the folder containing the item you specify.
  291. Returns    The offset number for the folder containing the specified item
  292. -1 if no archive is open
  293. -2 if the offset you specify is not an acceptable range
  294. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  295. Any other negative number if the item you specify does not exist
  296. Examples    StuffIt.getItemParent (StuffIt.getFirstItem())
  297.     »0 (the archive)
  298. See Also    StuffIt.getItemChild
  299. StuffIt.getFirstItem
  300. StuffIt.getNextItem
  301. StuffIt.getPreviousItem
  302. StuffIt.getItemCount
  303.  
  304. Verb    StuffIt.getItemSize
  305. Syntax    StuffIt.getItemSize(ID)
  306. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  307. Action    Gets the full size (uncompressed) of the item you specify with offset
  308. Returns    The size of the file, folder, or archive in bytes
  309. -1 if no archive is open
  310. -2 if the offset you specify is not an acceptable range
  311. -5 if the item at the offset is the end of a folder
  312. Any other negative number if the item you specify does not exist
  313. Examples    StuffIt.getItemSize (StuffIt.getFirstItem())
  314.     »26345 (the full, uncompressed size of the first item)
  315. See Also    StuffIt.getItemCompressedSize
  316.  
  317. Verb    StuffIt.getItemType
  318. Syntax    StuffIt.getItemType(ID)
  319. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  320. Action    Gets the four-letter string which indicates the file type
  321. Returns    The type of the file, folder, or archive
  322. -1 if no archive is open
  323. -2 if the offset you specify is not an acceptable range
  324. -5 if the item at the offset is the end of a folder
  325. Any other negative number if the item you specify does not exist
  326. Examples    StuffIt.getItemType (StuffIt.getFirstItem())
  327.     »TEXT (the first item is a text document)
  328. See Also    StuffIt.getItemCreator
  329. StuffIt.getItemKind
  330.  
  331. Verb    StuffIt.getNextItem
  332. Syntax    StuffIt.getNextItem(ID)
  333. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  334. Action    Gets the offset of the item that comes next in the archive, relative to the item you specify
  335. Returns    The offset of the next file, folder, or end-of-folder
  336. -1 if no archive is open
  337. -2 if the offset you specify is not an acceptable range
  338. -6 if the root of the archive (0) was specified
  339. 0 if there is no next item
  340. Any other negative number if the item you specify does not exist
  341. Examples    StuffIt.getNextItem (StuffIt.getFirstItem())
  342.     »134 (the second item (next after first) can be found at offset 134)
  343. See Also    StuffIt.getItemChild
  344. StuffIt.getItemParent
  345. StuffIt.getPreviousItem
  346. StuffIt.getFirstItem
  347.  
  348. Verb    StuffIt.getPreviousItem
  349. Syntax    StuffIt.getPreviousItem(ID)
  350. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  351. Action    Gets the offset of the item that comes before it in the archive, relative to the item you specify
  352. Returns    The offset of the previous file, folder, or end-of-folder
  353. -1 if no archive is open
  354. -2 if the offset you specify is not an acceptable range
  355. -6 if the root of the archive (0) was specified
  356. 0 if there is no previous item
  357. Any other negative number if the item you specify does not exist
  358. Examples    StuffIt.getPreviousItem (StuffIt.getNextItem(StuffIt.getFirstItem()))
  359.     »22 (the first item (previous of next of first))
  360. See Also    StuffIt.getItemChild
  361. StuffIt.getItemParent
  362. StuffIt.getNextItem
  363. StuffIt.getFirstItem
  364.  
  365. Verb    StuffIt.getVersion
  366. Syntax    StuffIt.getVersion ()
  367. Parameters    None
  368. Action    Gets the version information of the currenly running copy of StuffIt.
  369. Returns    The version of StuffIt you are running
  370. false (and an error) if StuffIt is not running
  371. Examples    StuffIt.getVersion ()
  372.     »StuffIt Deluxe™ 3.0 (the version of StuffIt which is running)
  373.  
  374. Verb    StuffIt.isFolder
  375. Syntax    StuffIt.isFolder (ID)
  376. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  377. Action    Determines if the item at the offset you specify is a folder
  378. Returns    true if the item you specify is a folder, false if it is not
  379. Examples    StuffIt.isFolder (22)
  380.     »true (the item at offset 22 is a folder)
  381. See Also    getItemKind
  382.  
  383. Verb    StuffIt.isRunning
  384. Syntax    StuffIt.isRunning ()
  385. Parameters    None
  386. Action    Determines if StuffIt is running
  387. Returns    true if StuffIt is running, false if it is not
  388. Examples    StuffIt.isRunning ()
  389.     »true (Of course you always keep StuffIt running!)
  390. Notes    Since this is based on the Frontier verb sys.appIsRunning, and StuffIt's creator signature has not changed at all, this will return true even if an older version is running.
  391. As a result, you should get the version of the program to make sure that it really is 3.0 or greater so that you can send it AppleEvents.
  392. See Also    StuffIt.getVersion
  393. StuffIt.launch
  394.  
  395. Verb    StuffIt.launch
  396. Syntax    StuffIt.launch ()
  397. Parameters    None
  398. Action    Opens StuffIt on your hard drive
  399. Returns    true if StuffIt was launched, false if it was not
  400. Examples    StuffIt.launch ()
  401.     »true (StuffIt was launched)
  402. Notes    The pathname of your copy of StuffIt is stored in StuffIt.appInfo.path. If you have moved StuffIt, or you are using this verb for the first time, you will get a dialog asking you to find your copy of StuffIt.
  403. Be sure to choose StuffIt 3.0, since the script only checks the creator of the file you select, and therefore any version of StuffIt would satisfy this dialog. This could be a problem if you want to send AppleEvents.
  404. See Also    StuffIt.getVersion
  405. StuffIt.isRunning
  406.  
  407. Verb    StuffIt.matchCriteria.addCommentBeginsWith
  408. Syntax    StuffIt.matchCriteria.addCommentBeginsWith (text)
  409. Parameters    text: the text you wish to use as the parameter for this Add Match command
  410. Action    Establishes, as an Add Match criteria, to add all files whose comments begin with the text you specify
  411. Returns    true if the event was successfully sent
  412. -1 if no archive is open
  413. Examples    StuffIt.matchCriteria.addCommentBeginsWith ("Cool")
  414. »true (the criterium was added to the Add Match qualifiers)
  415. Notes    As with StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments  begin with "Cool" and end with "Deal".
  416. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  417.  
  418. See Also    StuffIt.matchcriteria.addCommentContains
  419. StuffIt.matchcriteria.addCommentEndsWith
  420. StuffIt.matchcriteria.addCommentIs
  421. StuffIt.matchcriteria.addCommentIsNot
  422. StuffIt.matchcriteria.addCommentNotBeginsWith
  423. StuffIt.matchcriteria.addCommentNotContains
  424. StuffIt.matchcriteria.addCommentNotEndsWith
  425.  
  426. Verb    StuffIt.matchCriteria.addCommentContains
  427. Syntax    StuffIt.matchCriteria.addCommentContains (text)
  428. Parameters    text: the text you wish to use as the parameter for this Add Match command
  429. Action    Establishes, as an Add Match criteria, to add all files whose comments contain the text you specify
  430. Returns    true if the event was successfully sent
  431. -1 if no archive is open
  432. Examples    StuffIt.matchCriteria.addCommentContains ("Cool")
  433. »true (the criterium was added to the Add Match qualifiers)
  434. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  435. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  436.  
  437. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  438. StuffIt.matchcriteria.addCommentEndsWith
  439. StuffIt.matchcriteria.addCommentIs
  440. StuffIt.matchcriteria.addCommentIsNot
  441. StuffIt.matchcriteria.addCommentNotBeginsWith
  442. StuffIt.matchcriteria.addCommentNotContains
  443. StuffIt.matchcriteria.addCommentNotEndsWith
  444.  
  445. Verb    StuffIt.matchCriteria.addCommentEndsWith
  446. Syntax    StuffIt.matchCriteria.addCommentEndsWith (text)
  447. Parameters    text: the text you wish to use as the parameter for this Add Match command
  448. Action    Establishes, as an Add Match criteria, to add all files whose comments end with the text you specify
  449. Returns    true if the event was successfully sent
  450. -1 if no archive is open
  451. Examples    StuffIt.matchCriteria.addCommentEndsWith ("Deal")
  452. »true (the criterium was added to the Add Match qualifiers)
  453. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  454. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  455.  
  456. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  457. StuffIt.matchcriteria.addCommentContains
  458. StuffIt.matchcriteria.addCommentIs
  459. StuffIt.matchcriteria.addCommentIsNot
  460. StuffIt.matchcriteria.addCommentNotBeginsWith
  461. StuffIt.matchcriteria.addCommentNotContains
  462. StuffIt.matchcriteria.addCommentNotEndsWith
  463.  
  464. Verb    StuffIt.matchCriteria.addCommentIs
  465. Syntax    StuffIt.matchCriteria.addCommentIs (text)
  466. Parameters    text: the text you wish to use as the parameter for this Add Match command
  467. Action    Establishes, as an Add Match criteria, to add all files whose comments are exactly the text you specify
  468. Returns    true if the event was successfully sent
  469. -1 if no archive is open
  470. Examples    StuffIt.matchCriteria.addCommentIs ("Cool Deal")
  471. »true (the criterium was added to the Add Match qualifiers)
  472. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  473. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  474.  
  475. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  476. StuffIt.matchcriteria.addCommentContains
  477. StuffIt.matchcriteria.addCommentEndsWith
  478. StuffIt.matchcriteria.addCommentIsNot
  479. StuffIt.matchcriteria.addCommentNotBeginsWith
  480. StuffIt.matchcriteria.addCommentNotContains
  481. StuffIt.matchcriteria.addCommentNotEndsWith
  482.  
  483. Verb    StuffIt.matchCriteria.addCommentIsNot
  484. Syntax    StuffIt.matchCriteria.addCommentIsNot (text)
  485. Parameters    text: the text you wish to use as the parameter for this Add Match command
  486. Action    Establishes, as an Add Match criteria, to add all files whose comments are anything but the text you specify
  487. Returns    true if the event was successfully sent
  488. -1 if no archive is open
  489. Examples    StuffIt.matchCriteria.addCommentIsNot ("Cool Deal")
  490. »true (the criterium was added to the Add Match qualifiers)
  491. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  492. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  493.  
  494. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  495. StuffIt.matchcriteria.addCommentContains
  496. StuffIt.matchcriteria.addCommentEndsWith
  497. StuffIt.matchcriteria.addCommentIs
  498. StuffIt.matchcriteria.addCommentNotBeginsWith
  499. StuffIt.matchcriteria.addCommentNotContains
  500. StuffIt.matchcriteria.addCommentNotEndsWith
  501.  
  502. Verb    StuffIt.matchCriteria.addCommentNotBeginsWith
  503. Syntax    StuffIt.matchCriteria.addCommentNotBeginsWith (text)
  504. Parameters    text: the text you wish to use as the parameter for this Add Match command
  505. Action    Establishes, as an Add Match criteria, to add all files whose comments do not begin with the text you specify
  506. Returns    true if the event was successfully sent
  507. -1 if no archive is open
  508. Examples    StuffIt.matchCriteria.addCommentNotBeginsWith ("Cool")
  509. »true (the criterium was added to the Add Match qualifiers)
  510. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  511. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  512.  
  513. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  514. StuffIt.matchcriteria.addCommentContains
  515. StuffIt.matchcriteria.addCommentEndsWith
  516. StuffIt.matchcriteria.addCommentIs
  517. StuffIt.matchcriteria.addCommentIsNot
  518. StuffIt.matchcriteria.addCommentNotContains
  519. StuffIt.matchcriteria.addCommentNotEndsWith
  520.  
  521. Verb    StuffIt.matchCriteria.addCommentNotContains
  522. Syntax    StuffIt.matchCriteria.addCommentNotContains (text)
  523. Parameters    text: the text you wish to use as the parameter for this Add Match command
  524. Action    Establishes, as an Add Match criteria, to add all files whose comments do not contain the text you specify
  525. Returns    true if the event was successfully sent
  526. -1 if no archive is open
  527. Examples    StuffIt.matchCriteria.addCommentNotContains ("Cool")
  528. »true (the criterium was added to the Add Match qualifiers)
  529. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  530. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  531.  
  532. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  533. StuffIt.matchcriteria.addCommentContains
  534. StuffIt.matchcriteria.addCommentEndsWith
  535. StuffIt.matchcriteria.addCommentIs
  536. StuffIt.matchcriteria.addCommentIsNot
  537. StuffIt.matchcriteria.addCommentNotBeginsWith
  538. StuffIt.matchcriteria.addCommentNotEndsWith
  539.  
  540. Verb    StuffIt.matchCriteria.addCommentNotEndsWith
  541. Syntax    StuffIt.matchCriteria.addCommentNotEndsWith (text)
  542. Parameters    text: the text you wish to use as the parameter for this Add Match command
  543. Action    Establishes, as an Add Match criteria, to add all files whose comments do not end with the text you specify
  544. Returns    true if the event was successfully sent
  545. -1 if no archive is open
  546. Examples    StuffIt.matchCriteria.addCommentNotEndsWith ("Cool")
  547. »true (the criterium was added to the Add Match qualifiers)
  548. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  549. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  550.  
  551. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  552. StuffIt.matchcriteria.addCommentContains
  553. StuffIt.matchcriteria.addCommentEndsWith
  554. StuffIt.matchcriteria.addCommentIs
  555. StuffIt.matchcriteria.addCommentIsNot
  556. StuffIt.matchcriteria.addCommentNotBeginsWith
  557. StuffIt.matchcriteria.addCommentNotContains
  558.  
  559. Verb    StuffIt.matchCriteria.addCreatedAfter
  560. Syntax    StuffIt.matchCriteria.addCreatedAfter (date)
  561. Parameters    date: the date you wish to use as the parameter for this Add Match command
  562. Note: you can use the following key phrases instead of a specific date
  563. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  564. Action    Establishes, as an Add Match criteria, to add all files which were created after the date you specify
  565. Returns    true if the event was successfully sent
  566. -1 if no archive is open
  567. Examples    StuffIt.matchCriteria.addCreatedAfter ("this week")
  568. »true (the criterium was added to the Add Match qualifiers)
  569. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  570. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  571.  
  572. See Also    StuffIt.matchcriteria.addCreatedBefore
  573. StuffIt.matchcriteria.addCreatedBetween
  574. StuffIt.matchcriteria.addCreatedNotBetween
  575. StuffIt.matchcriteria.addCreatedOn
  576. StuffIt.matchcriteria.addCreatedNotOn
  577.  
  578. Verb    StuffIt.matchCriteria.addCreatedAfter
  579. Syntax    StuffIt.matchCriteria.addModifiedAfter (date)
  580. Parameters    date: the date you wish to use as the parameter for this Add Match command
  581. Note: you can use the following key phrases instead of a specific date
  582. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  583. Action    Establishes, as an Add Match criteria, to add all files which were modified after the date you specify
  584. Returns    true if the event was successfully sent
  585. -1 if no archive is open
  586. Examples    StuffIt.matchCriteria.addModifiedAfter ("this week")
  587. »true (the criterium was added to the Add Match qualifiers)
  588. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  589. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  590.  
  591. See Also    StuffIt.matchcriteria.addModifiedBefore
  592. StuffIt.matchcriteria.addModifiedBetween
  593. StuffIt.matchcriteria.addModifiedNotBetween
  594. StuffIt.matchcriteria.addModifiedOn
  595. StuffIt.matchcriteria.addModifiedNotOn
  596. StuffIt.matchcriteria.addModifiedSinceLastChange
  597.  
  598. Verb    StuffIt.matchCriteria.addCreatedBefore
  599. Syntax    StuffIt.matchCriteria.addCreatedBefore (date)
  600. Parameters    date: the date you wish to use as the parameter for this Add Match command
  601. Note: you can use the following key phrases instead of a specific date
  602. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  603. Action    Establishes, as an Add Match criteria, to add all files which were created before the date you specify
  604. Returns    true if the event was successfully sent
  605. -1 if no archive is open
  606. Examples    StuffIt.matchCriteria.addCreatedBefore ("this week")
  607. »true (the criterium was added to the Add Match qualifiers)
  608. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  609. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  610.  
  611. See Also    StuffIt.matchcriteria.addCreatedAfter
  612. StuffIt.matchcriteria.addCreatedBetween
  613. StuffIt.matchcriteria.addCreatedNotBetween
  614. StuffIt.matchcriteria.addCreatedOn
  615. StuffIt.matchcriteria.addCreatedNotOn
  616.  
  617. Verb    StuffIt.matchCriteria.addCreatedBefore
  618. Syntax    StuffIt.matchCriteria.addModifiedBefore (date)
  619. Parameters    date: the date you wish to use as the parameter for this Add Match command
  620. Note: you can use the following key phrases instead of a specific date
  621. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  622. Action    Establishes, as an Add Match criteria, to add all files which were modified before the date you specify
  623. Returns    true if the event was successfully sent
  624. -1 if no archive is open
  625. Examples    StuffIt.matchCriteria.addModifiedBefore ("this week")
  626. »true (the criterium was added to the Add Match qualifiers)
  627. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  628. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  629.  
  630. See Also    StuffIt.matchcriteria.addModifiedAfter
  631. StuffIt.matchcriteria.addModifiedBetween
  632. StuffIt.matchcriteria.addModifiedNotBetween
  633. StuffIt.matchcriteria.addModifiedOn
  634. StuffIt.matchcriteria.addModifiedNotOn
  635. StuffIt.matchcriteria.addModifiedSinceLastChange
  636.  
  637. Verb    StuffIt.matchCriteria.addCreatedBetween
  638. Syntax    StuffIt.matchCriteria.addCreatedBetween (date1, date2)
  639. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  640. Note: you can use the following key phrases instead of a specific date
  641. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  642. Action    Establishes, as an Add Match criteria, to add all files which were created between the dates you specify
  643. Returns    true if the event was successfully sent
  644. -1 if no archive is open
  645. Examples    StuffIt.matchCriteria.addCreatedBetween ("last week","today")
  646. »true (the criterium was added to the Add Match qualifiers)
  647. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  648. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  649. See Also    StuffIt.matchcriteria.addCreatedAfter
  650. StuffIt.matchcriteria.addCreatedBefore
  651. StuffIt.matchcriteria.addCreatedNotBetween
  652. StuffIt.matchcriteria.addCreatedOn
  653. StuffIt.matchcriteria.addCreatedNotOn
  654.  
  655. Verb    StuffIt.matchCriteria.addCreatedBetween
  656. Syntax    StuffIt.matchCriteria.addModifiedBetween (date1, date2)
  657. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  658. Note: you can use the following key phrases instead of a specific date
  659. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  660. Action    Establishes, as an Add Match criteria, to add all files which were modified between the dates you specify
  661. Returns    true if the event was successfully sent
  662. -1 if no archive is open
  663. Examples    StuffIt.matchCriteria.addModifiedBetween ("this week", "last year")
  664. »true (the criterium was added to the Add Match qualifiers)
  665. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  666. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  667.  
  668. See Also    StuffIt.matchcriteria.addModifiedAfter
  669. StuffIt.matchcriteria.addModifiedBefore
  670. StuffIt.matchcriteria.addModifiedNotBetween
  671. StuffIt.matchcriteria.addModifiedOn
  672. StuffIt.matchcriteria.addModifiedNotOn
  673. StuffIt.matchcriteria.addModifiedSinceLastChange
  674.  
  675. Verb    StuffIt.matchCriteria.addCreatedNotBetween
  676. Syntax    StuffIt.matchCriteria.addCreatedNotBetween (date1, date2)
  677. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  678. Note: you can use the following key phrases instead of a specific date
  679. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  680. Action    Establishes, as an Add Match criteria, to add all files which were not created between the dates you specify
  681. Returns    true if the event was successfully sent
  682. -1 if no archive is open
  683. Examples    StuffIt.matchCriteria.addCreatedNotBetween ("last week","today")
  684. »true (the criterium was added to the Add Match qualifiers)
  685. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  686. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  687.  
  688. See Also    StuffIt.matchcriteria.addCreatedAfter
  689. StuffIt.matchcriteria.addCreatedBefore
  690. StuffIt.matchcriteria.addCreatedBetween
  691. StuffIt.matchcriteria.addCreatedOn
  692. StuffIt.matchcriteria.addCreatedNotOn
  693.  
  694. Verb    StuffIt.matchCriteria.addCreatedNotBetween
  695. Syntax    StuffIt.matchCriteria.addModifiedNotBetween (date1, date2)
  696. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  697. Note: you can use the following key phrases instead of a specific date
  698. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  699. Action    Establishes, as an Add Match criteria, to add all files which were not modified between the dates you specify
  700. Returns    true if the event was successfully sent
  701. -1 if no archive is open
  702. Examples    StuffIt.matchCriteria.addModifiedNotBetween ("this week", "last year")
  703. »true (the criterium was added to the Add Match qualifiers)
  704. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  705. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  706.  
  707. See Also    StuffIt.matchcriteria.addModifiedAfter
  708. StuffIt.matchcriteria.addModifiedBefore
  709. StuffIt.matchcriteria.addModifiedBetween
  710. StuffIt.matchcriteria.addModifiedOn
  711. StuffIt.matchcriteria.addModifiedNotOn
  712. StuffIt.matchcriteria.addModifiedSinceLastChange
  713.  
  714. Verb    StuffIt.matchCriteria.addCreatedNotOn
  715. Syntax    StuffIt.matchCriteria.addCreatedNotOn (date)
  716. Parameters    date: the date you wish to use as the parameter for this Add Match command
  717. Note: you can use the following key phrases instead of a specific date
  718. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  719. Action    Establishes, as an Add Match criteria, to add all files which were not created on the date you specify
  720. Returns    true if the event was successfully sent
  721. -1 if no archive is open
  722. Examples    StuffIt.matchCriteria.addCreatedNotOn ("this week")
  723. »true (the criterium was added to the Add Match qualifiers)
  724. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  725. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  726.  
  727. See Also    StuffIt.matchcriteria.addCreatedAfter
  728. StuffIt.matchcriteria.addCreatedBetween
  729. StuffIt.matchcriteria.addCreatedNotBetween
  730. StuffIt.matchcriteria.addCreatedBefore
  731. StuffIt.matchcriteria.addCreatedOn
  732.  
  733. Verb    StuffIt.matchCriteria.addCreatedNotOn
  734. Syntax    StuffIt.matchCriteria.addModifiedNotOn (date)
  735. Parameters    date: the date you wish to use as the parameter for this Add Match command
  736. Note: you can use the following key phrases instead of a specific date
  737. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  738. Action    Establishes, as an Add Match criteria, to add all files which were not modified on the date you specify
  739. Returns    true if the event was successfully sent
  740. -1 if no archive is open
  741. Examples    StuffIt.matchCriteria.addModifiedNotOn ("this week")
  742. »true (the criterium was added to the Add Match qualifiers)
  743. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  744. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  745.  
  746. See Also    StuffIt.matchcriteria.addModifiedAfter
  747. StuffIt.matchcriteria.addModifiedBetween
  748. StuffIt.matchcriteria.addModifiedNotBetween
  749. StuffIt.matchcriteria.addModifiedBefore
  750. StuffIt.matchcriteria.addModifiedOn
  751. StuffIt.matchcriteria.addModifiedSinceLastChange
  752.  
  753. Verb    StuffIt.matchCriteria.addCreatedOn
  754. Syntax    StuffIt.matchCriteria.addCreatedOn (date)
  755. Parameters    date: the date you wish to use as the parameter for this Add Match command
  756. Note: you can use the following key phrases instead of a specific date
  757. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  758. Action    Establishes, as an Add Match criteria, to add all files which were created on the date you specify
  759. Returns    true if the event was successfully sent
  760. -1 if no archive is open
  761. Examples    StuffIt.matchCriteria.addCreatedOn ("yesterday")
  762. »true (the criterium was added to the Add Match qualifiers)
  763. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  764. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  765.  
  766. See Also    StuffIt.matchcriteria.addCreatedAfter
  767. StuffIt.matchcriteria.addCreatedBetween
  768. StuffIt.matchcriteria.addCreatedNotBetween
  769. StuffIt.matchcriteria.addCreatedBefore
  770. StuffIt.matchcriteria.addCreatedNotOn
  771.  
  772. Verb    StuffIt.matchCriteria.addCreatedOn
  773. Syntax    StuffIt.matchCriteria.addModifiedOn (date)
  774. Parameters    date: the date you wish to use as the parameter for this Add Match command
  775. Note: you can use the following key phrases instead of a specific date
  776. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  777. Action    Establishes, as an Add Match criteria, to add all files which were modified on the date you specify
  778. Returns    true if the event was successfully sent
  779. -1 if no archive is open
  780. Examples    StuffIt.matchCriteria.addModifiedOn ("this week")
  781. »true (the criterium was added to the Add Match qualifiers)
  782. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  783. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  784.  
  785. See Also    StuffIt.matchcriteria.addModifiedAfter
  786. StuffIt.matchcriteria.addModifiedBetween
  787. StuffIt.matchcriteria.addModifiedNotBetween
  788. StuffIt.matchcriteria.addModifiedBefore
  789. StuffIt.matchcriteria.addModifiedNotOn
  790. StuffIt.matchcriteria.addModifiedSinceLastChange
  791.  
  792. Verb    StuffIt.matchCriteria.addCreatedSinceLastChange
  793. Syntax    StuffIt.matchCriteria.addSinceLastChangeNotOn ()
  794. Parameters    None
  795. Action    Establishes, as an Add Match criteria, to add all files which were modified since the modified date of the archive
  796. Returns    true if the event was successfully sent
  797. -1 if no archive is open
  798. Examples    StuffIt.matchCriteria.addModifiedSinceLastChange ()
  799. »true (the criterium was added to the Add Match qualifiers)
  800. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  801. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  802.  
  803. See Also    StuffIt.matchcriteria.addModifiedAfter
  804. StuffIt.matchcriteria.addModifiedBetween
  805. StuffIt.matchcriteria.addModifiedNotBetween
  806. StuffIt.matchcriteria.addModifiedBefore
  807. StuffIt.matchcriteria.addModifiedOn
  808. StuffIt.matchcriteria.addModifiedNotOn
  809.  
  810. Verb    StuffIt.matchCriteria.addKindBeginsWith
  811. Syntax    StuffIt.matchCriteria.addKindBeginsWith (type)
  812. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  813. Action    Establishes, as an Add Match criteria, to add all files whose kinds begin with the type you specify
  814. Returns    true if the event was successfully sent
  815. -1 if no archive is open
  816. Examples    StuffIt.matchCriteria.addKindBeginsWith ("app")
  817. »true (the criterium was added to the Add Match qualifiers)
  818. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  819. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  820.  
  821. See Also    StuffIt.matchcriteria.addKindContains
  822. StuffIt.matchcriteria.addKindEndsWith
  823. StuffIt.matchcriteria.addKindIs
  824. StuffIt.matchcriteria.addKindIsNot
  825. StuffIt.matchcriteria.addKindNotBeginsWith
  826. StuffIt.matchcriteria.addKindNotContains
  827. StuffIt.matchcriteria.addKindNotEndsWith
  828.  
  829. Verb    StuffIt.matchCriteria.addKindContains
  830. Syntax    StuffIt.matchCriteria.addKindContains (type)
  831. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  832. Action    Establishes, as an Add Match criteria, to add all files whose kinds contain the type you specify
  833. Returns    true if the event was successfully sent
  834. -1 if no archive is open
  835. Examples    StuffIt.matchCriteria.addKindContains ("app")
  836. »true (the criterium was added to the Add Match qualifiers)
  837. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  838. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  839.  
  840. See Also    StuffIt.matchcriteria.addKindBeginsWith
  841. StuffIt.matchcriteria.addKindEndsWith
  842. StuffIt.matchcriteria.addKindIs
  843. StuffIt.matchcriteria.addKindIsNot
  844. StuffIt.matchcriteria.addKindNotBeginsWith
  845. StuffIt.matchcriteria.addKindNotContains
  846. StuffIt.matchcriteria.addKindNotEndsWith
  847.  
  848. Verb    StuffIt.matchCriteria.addKindEndsWith
  849. Syntax    StuffIt.matchCriteria.addKindEndsWith (type)
  850. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  851. Action    Establishes, as an Add Match criteria, to add all files whose kinds end with the type you specify
  852. Returns    true if the event was successfully sent
  853. -1 if no archive is open
  854. Examples    StuffIt.matchCriteria.addKindEndsWith ("app")
  855. »true (the criterium was added to the Add Match qualifiers)
  856. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  857. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  858.  
  859. See Also    StuffIt.matchcriteria.addKindBeginsWith
  860. StuffIt.matchcriteria.addKindContains
  861. StuffIt.matchcriteria.addKindIs
  862. StuffIt.matchcriteria.addKindIsNot
  863. StuffIt.matchcriteria.addKindNotBeginsWith
  864. StuffIt.matchcriteria.addKindNotContains
  865. StuffIt.matchcriteria.addKindNotEndsWith
  866.  
  867. Verb    StuffIt.matchCriteria.addKindIs
  868. Syntax    StuffIt.matchCriteria.addKindIs (type)
  869. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  870. Action    Establishes, as an Add Match criteria, to add all files whose kinds are exactly the type you specify
  871. Returns    true if the event was successfully sent
  872. -1 if no archive is open
  873. Examples    StuffIt.matchCriteria.addKindIs ("app")
  874. »true (the criterium was added to the Add Match qualifiers)
  875. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  876. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  877.  
  878. See Also    StuffIt.matchcriteria.addKindBeginsWith
  879. StuffIt.matchcriteria.addKindContains
  880. StuffIt.matchcriteria.addKindEndsWith
  881. StuffIt.matchcriteria.addKindIsNot
  882. StuffIt.matchcriteria.addKindNotBeginsWith
  883. StuffIt.matchcriteria.addKindNotContains
  884. StuffIt.matchcriteria.addKindNotEndsWith
  885.  
  886. Verb    StuffIt.matchCriteria.addKindIs
  887. Syntax    StuffIt.matchCriteria.addKindIsNot (type)
  888. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  889. Action    Establishes, as an Add Match criteria, to add all files whose kinds are not exactly the type you specify
  890. Returns    true if the event was successfully sent
  891. -1 if no archive is open
  892. Examples    StuffIt.matchCriteria.addKindIsNot ("app")
  893. »true (the criterium was added to the Add Match qualifiers)
  894. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  895. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  896.  
  897. See Also    StuffIt.matchcriteria.addKindBeginsWith
  898. StuffIt.matchcriteria.addKindContains
  899. StuffIt.matchcriteria.addKindEndsWith
  900. StuffIt.matchcriteria.addKindIs
  901. StuffIt.matchcriteria.addKindNotBeginsWith
  902. StuffIt.matchcriteria.addKindNotContains
  903. StuffIt.matchcriteria.addKindNotEndsWith
  904.  
  905. Verb    StuffIt.matchCriteria.addKindNotBeginsWith
  906. Syntax    StuffIt.matchCriteria.addNotBeginsWith (type)
  907. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  908. Action    Establishes, as an Add Match criteria, to add all files whose kinds do not begin with the type you specify
  909. Returns    true if the event was successfully sent
  910. -1 if no archive is open
  911. Examples    StuffIt.matchCriteria.addKindNotBeginsWith ("app")
  912. »true (the criterium was added to the Add Match qualifiers)
  913. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  914. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  915.  
  916. See Also    StuffIt.matchcriteria.addKindBeginsWith
  917. StuffIt.matchcriteria.addKindContains
  918. StuffIt.matchcriteria.addKindEndsWith
  919. StuffIt.matchcriteria.addKindIs
  920. StuffIt.matchcriteria.addKindIsNot
  921. StuffIt.matchcriteria.addKindNotContains
  922. StuffIt.matchcriteria.addKindNotEndsWith
  923.  
  924. Verb    StuffIt.matchCriteria.addKindNotContains
  925. Syntax    StuffIt.matchCriteria.addNotContains (type)
  926. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  927. Action    Establishes, as an Add Match criteria, to add all files whose kinds do not contain the type you specify
  928. Returns    true if the event was successfully sent
  929. -1 if no archive is open
  930. Examples    StuffIt.matchCriteria.addKindNotContains ("app")
  931. »true (the criterium was added to the Add Match qualifiers)
  932. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  933. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  934.  
  935. See Also    StuffIt.matchcriteria.addKindBeginsWith
  936. StuffIt.matchcriteria.addKindContains
  937. StuffIt.matchcriteria.addKindEndsWith
  938. StuffIt.matchcriteria.addKindIs
  939. StuffIt.matchcriteria.addKindIsNot
  940. StuffIt.matchcriteria.addKindNotBeginsWith
  941. StuffIt.matchcriteria.addKindNotEndsWith
  942.  
  943. Verb    StuffIt.matchCriteria.addKindNotEndsWith
  944. Syntax    StuffIt.matchCriteria.addNotEndsWith (type)
  945. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  946. Action    Establishes, as an Add Match criteria, to add all files whose kinds do not end with the type you specify
  947. Returns    true if the event was successfully sent
  948. -1 if no archive is open
  949. Examples    StuffIt.matchCriteria.addKindNotEndsWith ("app")
  950. »true (the criterium was added to the Add Match qualifiers)
  951. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  952. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  953.  
  954. See Also    StuffIt.matchcriteria.addKindBeginsWith
  955. StuffIt.matchcriteria.addKindContains
  956. StuffIt.matchcriteria.addKindEndsWith
  957. StuffIt.matchcriteria.addKindIs
  958. StuffIt.matchcriteria.addKindIsNot
  959. StuffIt.matchcriteria.addKindNotBeginsWith
  960. StuffIt.matchcriteria.addKindNotContains
  961.  
  962. Verb    StuffIt.matchCriteria.addLabelIs
  963. Syntax    StuffIt.matchCriteria.addLabelIs (label)
  964. Parameters    label: the label you wish to use as a qualifier for this Add Match command
  965. Action    Establishes, as an Add Match criteria, to add all files whose label is the one you specify
  966. Returns    true if the event was successfully sent
  967. -1 if no archive is open
  968. Examples    StuffIt.matchCriteria.addLabelIs ("Don't Backup")
  969. »true (the criterium was added to the Add Match qualifiers)
  970. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose labels are "Don't backup" and all files whose label is "System software"
  971. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  972.  
  973. See Also    StuffIt.matchcriteria.addLabelIsNot
  974.  
  975. Verb    StuffIt.matchCriteria.addLabelIsNot
  976. Syntax    StuffIt.matchCriteria.addLabelIsNot (label)
  977. Parameters    label: the label you wish to use as a qualifier for this Add Match command
  978. Action    Establishes, as an Add Match criteria, to add all files whose label is not the one you specify
  979. Returns    true if the event was successfully sent
  980. -1 if no archive is open
  981. Examples    StuffIt.matchCriteria.addLabelIsNot ("System Software")
  982. »true (the criterium was added to the Add Match qualifiers)
  983. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  984. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  985.  
  986. See Also    StuffIt.matchcriteria.addLabelIs
  987.  
  988. Verb    StuffIt.matchCriteria.addNameBeginsWith
  989. Syntax    StuffIt.matchCriteria.addNameBeginsWith (text)
  990. Parameters    text: the text you wish to use as a parameter for this Add Match command
  991. Action    Establishes, as an Add Match criteria, to add all files whose names begin with the text you specify
  992. Returns    true if the event was successfully sent
  993. -1 if no archive is open
  994. Examples    StuffIt.matchCriteria.addNameBeginsWith ("app")
  995. »true (the criterium was added to the Add Match qualifiers)
  996. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  997. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  998.  
  999. See Also    StuffIt.matchcriteria.addNameContains
  1000. StuffIt.matchcriteria.addNameEndsWith
  1001. StuffIt.matchcriteria.addNameIs
  1002. StuffIt.matchcriteria.addNameIsNot
  1003. StuffIt.matchcriteria.addNameNotBeginsWith
  1004. StuffIt.matchcriteria.addNameNotContains
  1005. StuffIt.matchcriteria.addNameNotEndsWith
  1006.  
  1007. Verb    StuffIt.matchCriteria.addNameContains
  1008. Syntax    StuffIt.matchCriteria.addNameContains (text)
  1009. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1010. Action    Establishes, as an Add Match criteria, to add all files whose names contain the text you specify
  1011. Returns    true if the event was successfully sent
  1012. -1 if no archive is open
  1013. Examples    StuffIt.matchCriteria.addNameContains ("app")
  1014. »true (the criterium was added to the Add Match qualifiers)
  1015. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1016. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1017.  
  1018. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1019. StuffIt.matchcriteria.addNameEndsWith
  1020. StuffIt.matchcriteria.addNameIs
  1021. StuffIt.matchcriteria.addNameIsNot
  1022. StuffIt.matchcriteria.addNameNotBeginsWith
  1023. StuffIt.matchcriteria.addNameNotContains
  1024. StuffIt.matchcriteria.addNameNotEndsWith
  1025.  
  1026. Verb    StuffIt.matchCriteria.addNameEndsWith
  1027. Syntax    StuffIt.matchCriteria.addNameEndsWith (text)
  1028. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1029. Action    Establishes, as an Add Match criteria, to add all files whose names end with the text you specify
  1030. Returns    true if the event was successfully sent
  1031. -1 if no archive is open
  1032. Examples    StuffIt.matchCriteria.addNameEndsWith ("app")
  1033. »true (the criterium was added to the Add Match qualifiers)
  1034. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1035. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1036.  
  1037. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1038. StuffIt.matchcriteria.addNameContains
  1039. StuffIt.matchcriteria.addNameIs
  1040. StuffIt.matchcriteria.addNameIsNot
  1041. StuffIt.matchcriteria.addNameNotBeginsWith
  1042. StuffIt.matchcriteria.addNameNotContains
  1043. StuffIt.matchcriteria.addNameNotEndsWith
  1044.  
  1045. Verb    StuffIt.matchCriteria.addNameIs
  1046. Syntax    StuffIt.matchCriteria.addNameIs (text)
  1047. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1048. Action    Establishes, as an Add Match criteria, to add all files whose names are exactly the text you specify
  1049. Returns    true if the event was successfully sent
  1050. -1 if no archive is open
  1051. Examples    StuffIt.matchCriteria.addNameIs ("app")
  1052. »true (the criterium was added to the Add Match qualifiers)
  1053. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1054. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1055.  
  1056. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1057. StuffIt.matchcriteria.addNameContains
  1058. StuffIt.matchcriteria.addNameEndsWith
  1059. StuffIt.matchcriteria.addNameIsNot
  1060. StuffIt.matchcriteria.addNameNotBeginsWith
  1061. StuffIt.matchcriteria.addNameNotContains
  1062. StuffIt.matchcriteria.addNameNotEndsWith
  1063.  
  1064. Verb    StuffIt.matchCriteria.addNameIsNot
  1065. Syntax    StuffIt.matchCriteria.addNameIsNot (text)
  1066. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1067. Action    Establishes, as an Add Match criteria, to add all files whose names are not exactly the text you specify
  1068. Returns    true if the event was successfully sent
  1069. -1 if no archive is open
  1070. Examples    StuffIt.matchCriteria.addNameIsNot ("app")
  1071. »true (the criterium was added to the Add Match qualifiers)
  1072. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1073. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1074.  
  1075. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1076. StuffIt.matchcriteria.addNameContains
  1077. StuffIt.matchcriteria.addNameEndsWith
  1078. StuffIt.matchcriteria.addNameIs
  1079. StuffIt.matchcriteria.addNameNotBeginsWith
  1080. StuffIt.matchcriteria.addNameNotContains
  1081. StuffIt.matchcriteria.addNameNotEndsWith
  1082.  
  1083. Verb    StuffIt.matchCriteria.addNameNotBeginsWith
  1084. Syntax    StuffIt.matchCriteria.addNameNotBeginsWith (text)
  1085. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1086. Action    Establishes, as an Add Match criteria, to add all files whose names do not begin with the text you specify
  1087. Returns    true if the event was successfully sent
  1088. -1 if no archive is open
  1089. Examples    StuffIt.matchCriteria.addNameNotBeginsWith ("app")
  1090. »true (the criterium was added to the Add Match qualifiers)
  1091. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1092. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1093.  
  1094. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1095. StuffIt.matchcriteria.addNameContains
  1096. StuffIt.matchcriteria.addNameEndsWith
  1097. StuffIt.matchcriteria.addNameIs
  1098. StuffIt.matchcriteria.addNameIsNot
  1099. StuffIt.matchcriteria.addNameNotContains
  1100. StuffIt.matchcriteria.addNameNotEndsWith
  1101.  
  1102. Verb    StuffIt.matchCriteria.addNameNotContains
  1103. Syntax    StuffIt.matchCriteria.addNameNotContains (text)
  1104. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1105. Action    Establishes, as an Add Match criteria, to add all files whose names do not contain the text you specify
  1106. Returns    true if the event was successfully sent
  1107. -1 if no archive is open
  1108. Examples    StuffIt.matchCriteria.addNameNotContains ("app")
  1109. »true (the criterium was added to the Add Match qualifiers)
  1110. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1111. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1112.  
  1113. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1114. StuffIt.matchcriteria.addNameContains
  1115. StuffIt.matchcriteria.addNameEndsWith
  1116. StuffIt.matchcriteria.addNameIs
  1117. StuffIt.matchcriteria.addNameIsNot
  1118. StuffIt.matchcriteria.addNameNotBeginsWith
  1119. StuffIt.matchcriteria.addNameNotEndsWith
  1120.  
  1121. Verb    StuffIt.matchCriteria.addNameNotEndsWith
  1122. Syntax    StuffIt.matchCriteria.addNameNotEndsWith (text)
  1123. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1124. Action    Establishes, as an Add Match criteria, to add all files whose names do not end with the text you specify
  1125. Returns    true if the event was successfully sent
  1126. -1 if no archive is open
  1127. Examples    StuffIt.matchCriteria.addNameNotEndsWith ("app")
  1128. »true (the criterium was added to the Add Match qualifiers)
  1129. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1130. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1131.  
  1132. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1133. StuffIt.matchcriteria.addNameContains
  1134. StuffIt.matchcriteria.addNameEndsWith
  1135. StuffIt.matchcriteria.addNameIs
  1136. StuffIt.matchcriteria.addNameIsNot
  1137. StuffIt.matchcriteria.addNameNotBeginsWith
  1138. StuffIt.matchcriteria.addNameNotContains
  1139.  
  1140. Verb    StuffIt.matchCriteria.addSizeIs
  1141. Syntax    StuffIt.matchCriteria.addSizeIs (number)
  1142. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1143. Action    Establishes, as an Add Match criteria, to add all files which are the same number of kilobytes as number
  1144. Returns    true if the event was successfully sent
  1145. -1 if no archive is open
  1146. Examples    StuffIt.matchCriteria.addSizeIs ("123456")
  1147. »true (the criterium was added to the Add Match qualifiers)
  1148. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1149. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1150.  
  1151. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1152. StuffIt.matchcriteria.addSizeIsNotBetween
  1153. StuffIt.matchcriteria.addSizeIsGreaterThan
  1154. StuffIt.matchcriteria.addSizeIsLessThan
  1155. StuffIt.matchcriteria.addSizeIsNot
  1156.  
  1157. Verb    StuffIt.matchCriteria.addSizeIsBetween
  1158. Syntax    StuffIt.matchCriteria.addSizeIsBetween (number1,number2)
  1159. Parameters    number1, number2: the sizes (in K) you wish to use as parameters for this Add Match command.
  1160. Action    Establishes, as an Add Match criteria, to add all files which are between the sizes you specify
  1161. Returns    true if the event was successfully sent
  1162. -1 if no archive is open
  1163. Examples    StuffIt.matchCriteria.addSizeIsBetween ("123456", "345956")
  1164. »true (the criterium was added to the Add Match qualifiers)
  1165. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1166. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1167. See Also    StuffIt.matchcriteria.addSizeIs
  1168. StuffIt.matchcriteria.addSizeIsNotBetween
  1169. StuffIt.matchcriteria.addSizeIsGreaterThan
  1170. StuffIt.matchcriteria.addSizeIsLessThan
  1171. StuffIt.matchcriteria.addSizeIsNot
  1172.  
  1173. Verb    StuffIt.matchCriteria.addSizeIsGreaterThan
  1174. Syntax    StuffIt.matchCriteria.addSizeIsGreaterThan (number)
  1175. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1176. Action    Establishes, as an Add Match criteria, to add all files which are bigger than the size you specify
  1177. Returns    true if the event was successfully sent
  1178. -1 if no archive is open
  1179. Examples    StuffIt.matchCriteria.addSizeIsGreaterThan ("123456")
  1180. »true (the criterium was added to the Add Match qualifiers)
  1181. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1182. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1183.  
  1184. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1185. StuffIt.matchcriteria.addSizeIsNotBetween
  1186. StuffIt.matchcriteria.addSizeIs
  1187. StuffIt.matchcriteria.addSizeIsLessThan
  1188. StuffIt.matchcriteria.addSizeIsNot
  1189.  
  1190. Verb    StuffIt.matchCriteria.addSizeIsLessThan
  1191. Syntax    StuffIt.matchCriteria.addSizeIsLessThan (number)
  1192. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1193. Action    Establishes, as an Add Match criteria, to add all files which are smaller than the size you specify
  1194. Returns    true if the event was successfully sent
  1195. -1 if no archive is open
  1196. Examples    StuffIt.matchCriteria.addSizeIsLessThan ("123456")
  1197. »true (the criterium was added to the Add Match qualifiers)
  1198. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1199. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1200.  
  1201. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1202. StuffIt.matchcriteria.addSizeIsNotBetween
  1203. StuffIt.matchcriteria.addSizeIs
  1204. StuffIt.matchcriteria.addSizeIsGreaterThan
  1205. StuffIt.matchcriteria.addSizeIsNot
  1206.  
  1207. Verb    StuffIt.matchCriteria.addSizeIsNot
  1208. Syntax    StuffIt.matchCriteria.addSizeIsNot (number)
  1209. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1210. Action    Establishes, as an Add Match criteria, to add all files which are not the size you specify
  1211. Returns    true if the event was successfully sent
  1212. -1 if no archive is open
  1213. Examples    StuffIt.matchCriteria.addSizeIsNot ("123456")
  1214. »true (the criterium was added to the Add Match qualifiers)
  1215. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1216. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1217.  
  1218. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1219. StuffIt.matchcriteria.addSizeIsNotBetween
  1220. StuffIt.matchcriteria.addSizeIs
  1221. StuffIt.matchcriteria.addSizeIsGreaterThan
  1222. StuffIt.matchcriteria.addSizeIsLessThan
  1223.  
  1224. Verb    StuffIt.matchCriteria.addSizeIsNotBetween
  1225. Syntax    StuffIt.matchCriteria.addSizeIsNotBetween (number1,number2)
  1226. Parameters    number1, number2: the sizes (in K) you wish to use as parameters for this Add Match command.
  1227. Action    Establishes, as an Add Match criteria, to add all files which are not between the sizes you specify
  1228. Returns    true if the event was successfully sent
  1229. -1 if no archive is open
  1230. Examples    StuffIt.matchCriteria.addSizeIsNotBetween ("123456", "345956")
  1231. »true (the criterium was added to the Add Match qualifiers)
  1232. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1233. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1234.  
  1235. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1236. StuffIt.matchcriteria.addSizeIs
  1237. StuffIt.matchcriteria.addSizeIsGreaterThan
  1238. StuffIt.matchcriteria.addSizeIsLessThan
  1239. StuffIt.matchcriteria.addSizeIsNot
  1240.  
  1241. Verb    StuffIt.matchCriteria.addTypeCreatorIs
  1242. Syntax    StuffIt.matchCriteria.addTypeCreatorIs (type,creator)
  1243. Parameters    type: the four-letter filetype you wish to use as a parameter
  1244. creator: the four-letter application signature you wish to use as a parameter
  1245. Action    Establishes, as an Add Match criteria, to add all files whose types and creators are the ones you specify
  1246. Returns    true if the event was successfully sent
  1247. -1 if no archive is open
  1248. Examples    StuffIt.matchCriteria.addTypeCreatorIs ("ttro","ttxt")
  1249. »true (the criterium was added to the Add Match qualifiers)
  1250. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all MacWrite II documents and all ResEdit documents
  1251. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1252.  
  1253. See Also    StuffIt.matchcriteria.addTypeCreatorIsNot
  1254.  
  1255. Verb    StuffIt.matchCriteria.addTypeCreatorIsNot
  1256. Syntax    StuffIt.matchCriteria.addTypeCreatorIsNot (type,creator)
  1257. Parameters    type: the four-letter filetype you wish to use as a parameter
  1258. creator: the four-letter application signature you wish to use as a parameter
  1259. Action    Establishes, as an Add Match criteria, to add all files whose types and creators are not the ones you specify
  1260. Returns    true if the event was successfully sent
  1261. -1 if no archive is open
  1262. Examples    StuffIt.matchCriteria.addTypeCreatorIsNot ("ttro","ttxt")
  1263. »true (the criterium was added to the Add Match qualifiers)
  1264. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all MacWrite II documents and all ResEdit documents
  1265. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1266.  
  1267. See Also    StuffIt.matchcriteria.addTypeCreatorIs
  1268.  
  1269. Verb    StuffIt.matchCriteria.clear
  1270. Syntax    StuffIt.matchCriteria.clear ()
  1271. Parameters    None
  1272. Action    Clears the settings for the Add Match, allowing you to begin again
  1273. Returns    true or false, depending on success
  1274. Examples    StuffIt.matchCriteria.clear ()
  1275. »true (Add Match criteria were cleared from memory)
  1276.  
  1277. Verb    StuffIt.newArchive
  1278. Syntax    StuffIt.newArchive (path, is151)
  1279. Parameters    path: the full path of the location where you want to put this archive
  1280. is151: true or false, determines if the new archive will be a StuffIt 1.5.1 document
  1281. Action    Makes a new archive at the place you specify. You can make it either a StuffIt Deluxe document or a StuffIt 1.5.1 document
  1282. Returns    0 if there was no error
  1283. a negative number indicates an operating System error
  1284. 2 if there are already too many archives open
  1285. Examples    StuffIt.newArchive ("My HD:My Folder:My StuffIt File",false)
  1286. »true (makes a new StuffIt archive named "My StuffIt File")
  1287. Notes    Remember that StuffIt 1.5.1 documents can not be manipulated by many of these verbs. Check each verb specifically.
  1288. This verb will overwrite a file with the same pathname. So if a file already exists with the same name at the location you specify, it will be erased.
  1289. See Also    StuffIt.openArchive
  1290. StuffIt.archive.getMaxCount
  1291. StuffIt.archive.close
  1292.  
  1293. Verb    StuffIt.newFolder
  1294. Syntax    StuffIt.newFolder (name)
  1295. Parameters    name: the name of the folder you wish to create
  1296. Action    Makes a new folder, with the name you specify, on the current level of the current archive.
  1297. Returns    true if the folder was successfully made
  1298. Examples    StuffIt.newFolder ("Cool Things folder")
  1299.     »true (makes a new folder in the current level named "Cool Things folder")
  1300. See Also    StuffIt.openFolder
  1301. StuffIt.getCurrentFolder
  1302.  
  1303. Verb    StuffIt.openArchive
  1304. Syntax    StuffIt.openArchive (path)
  1305. Parameters    path: the pathname of the archive you wish to open
  1306. Action    StuffIt will attempt to open the archive you specify
  1307. Returns    true if the archive was successfully opened
  1308. Examples    StuffIt.openArchive ("My HD:My Folder:My StuffIt File")
  1309.     »true (opens My StuffIt File)
  1310. Notes    When you open an archive, it will become the current archive (index 0). If you open an archive which is already open, StuffIt will still return true.
  1311. This has the same function as required.openDocument(path)
  1312. See Also    StuffIt.archive.getMaxCount
  1313. StuffIt.newArchive
  1314. StuffIt.closeArchive
  1315.  
  1316. Verb    StuffIt.openFolder
  1317. Syntax    StuffIt.openFolder (ID)
  1318. Parameters    ID: the offset which contains the information for this item. This number is based on a propietary numbering scheme of StuffIt.
  1319. Action    Opens the folder at the ID you specify and makes it the current level
  1320. Returns    0 if there was no error
  1321. -1 if no archive is open
  1322. -2 if the offset you specify is out of range
  1323. -3 if the item is not a folder
  1324. -4 if the frontmost archive is a StuffIt 1.5.1 document
  1325. Examples    StuffIt.openFolder (StuffIt.getFirstItem())
  1326.     »0 (opens the first item (which is a folder))
  1327. StuffIt.openFolder (StuffIt.getFirstItem())
  1328.     »-3 (the first item is not a folder)
  1329. See Also    StuffIt.isFolder
  1330. StuffIt.getItemKind
  1331. StuffIt.newFolder
  1332. StuffIt.getCurrentFolder
  1333.  
  1334. Verb    StuffIt.outlineArchive
  1335. Syntax    StuffIt.outlineArchive (pathname,outlineAddress,details)
  1336. Parameters    pathname: the full path of the archive you wish to outline
  1337. outlineAddress: the address in the Frontier Database where you want to place the outline
  1338. details: true or false. True if you want to include information such as size, type, creator, and modified date, for each file.
  1339. Action    Outlines the archive you specify
  1340. Returns    true if there was no error
  1341. Examples    StuffIt.outlineArchive ("My HD:My Folder:My StuffItFile",@people.[user.initials].archiveoutline,true)
  1342.     »true (outline was successfully made for the archive My StuffItFile. For an example, look at StuffIt.ArchiveOutline)
  1343.  
  1344. Verb    StuffIt.password.isSet
  1345. Syntax    StuffIt.password.isSet ()
  1346. Parameters    None
  1347. Action    returns true is the current archive has a password assigned to it
  1348. Returns    true if there is a password on the archive
  1349. Examples    StuffIt.password.isSet ()
  1350.     »true
  1351. See Also    StuffIt.encryptItem
  1352. StuffIt.password.set
  1353.  
  1354. Verb    StuffIt.password.set
  1355. Syntax    StuffIt.password.set (password)
  1356. Parameters    password: the password you wish to use for stuffing or unstuffing items
  1357. Action    assigns password to the current archive in order to encrypt files as they are stuffed
  1358. Returns    true if the password was accepted
  1359. false will be returned if the password already has an archive
  1360. Examples    StuffIt.password.set ("secret")
  1361.     »true
  1362. See Also    StuffIt.encryptItem
  1363. StuffIt.password.isSet
  1364.  
  1365. Verb    StuffIt.quit
  1366. Syntax    StuffIt.quit ()
  1367. Parameters    None
  1368. Action    Quits StuffIt Deluxe
  1369. Returns    true if there was no error
  1370. Examples    StuffIt.quit ()
  1371.     »true (quits StuffIt Deluxe)
  1372. Notes    this verb uses required.quitApplication
  1373. See Also    StuffIt.launch
  1374. StuffIt.isRunning
  1375.  
  1376. Verb    StuffIt.renameItem
  1377. Syntax    StuffIt.renameItem (ID,newName)
  1378. Parameters    ID: The offset in the archive of the item you wish to rename. This offset is based on a propietary numbering scheme in StuffIt, so there's no way to set it.
  1379. newName: the new name of the item you specified
  1380. Action    Renames the item at the ID you specify.
  1381. Returns    0 if there was no error
  1382. -1 if no archive is open
  1383. -2 if the index you specify is out of range
  1384. -3 if the offset you specify cannot be renamed (i.e., is an end-of-folder)
  1385. -4 if the current archive is a StuffIt 1.5.1 document
  1386. Examples    StuffIt.renameItem (StuffIt.getFirstItem(),"Cool Things 2")
  1387.     »0 (renames the first item in the archive to Cool Things 2)
  1388. See Also    StuffIt.getItemName
  1389. StuffIt.selection.rename
  1390.  
  1391. Verb    StuffIt.saveAs
  1392. Syntax    StuffIt.saveAs (path)
  1393. Parameters    path: the full pathname of the location where you would like to save the archive
  1394. Action    Saves a copy of the current archive at the location you specify
  1395. Returns    true if there was no error
  1396. -1 if no archive was open
  1397. Examples    StuffIt.saveAs ("My HD:My Folder:My Backup")
  1398.     »true (saves a copy of this archive as My Backup)
  1399. Notes    This verb will not overwrite a pre-existing file with the same name.
  1400.  
  1401. Verb    StuffIt.sea.attach
  1402. Syntax    StuffIt.sea.attach ()
  1403. Parameters    None
  1404. Action    Makes the frontmost archive into a self-extracting archive (SEA)
  1405. Returns    true if there was no error
  1406. -1 if no archive was open
  1407. Examples    StuffIt.sea.attach ()
  1408.     »true (the frontmost archive is now a self-extracting archive)
  1409. See Also    StuffIt.sea.isSEA
  1410. StuffIt.sea.remove
  1411.  
  1412. Verb    StuffIt.sea.isSEA
  1413. Syntax    StuffIt.sea.isSEA ()
  1414. Parameters    None
  1415. Action    Determines whether or not the frontmost archive is self-extracting
  1416. Returns    true if the current archive is a self-extracting archive
  1417. -1 if no archive was open
  1418. Examples    StuffIt.sea.isSEA ()
  1419.     »false (The frontmost archive is not self-extracting)
  1420. See Also    StuffIt.sea.attach
  1421. StuffIt.sea.remove
  1422.  
  1423. Verb    StuffIt.sea.remove
  1424. Syntax    StuffIt.sea.remove ()
  1425. Parameters    None
  1426. Action    Removes the self-extracting code from an archive
  1427. Returns    true if there was no error
  1428. -1 if no archive was open
  1429. Examples    StuffIt.sea.remove ()
  1430.     »true (This archive is no longer self-extracting)
  1431. Notes    This verb will return true even if the file is not self-extracting.
  1432. See Also    StuffIt.sea.attach
  1433. StuffIt.sea.isSEA
  1434.  
  1435. Verb    StuffIt.sea.saveAsSEA
  1436. Syntax    StuffIt.sea.saveAsSEA (path)
  1437. Parameters    path: the full pathname of the destination for your new archive
  1438. Action    Creates a copy of the current archive, and then saves it as self-extracting in the location you specify
  1439. Returns    true if there was no error
  1440. -1 if no archive was open
  1441. Examples    StuffIt.sea.saveAsSEA ("My HD:My Folder:My Backup")
  1442.     »true (the current archive was saved as My Backup and made into a self-extracting archive)
  1443. Notes    This verb will not overwrite any pre-existing file with the same name
  1444.  
  1445. Verb    StuffIt.segmenting.join
  1446. Syntax    StuffIt.segmenting.join (pathname, replace, prompt)
  1447. Parameters    pathname: the filenames of the items you wish to join (wildcards are accepted)
  1448. replace: true or false. Determines whether or not to replace items with the same name
  1449. prompt: true or false. Determines whether or not to notify user of collision errors or name conflicts
  1450. Action    Joins the files you specify into one file
  1451. Returns    true if the files were joined, false if they were not
  1452. Examples    StuffIt.segmenting.join ("My HD:My Folder:My segments",true,false)
  1453.     »true (the files were joined, and any items with the same name were replaced)
  1454. See Also    StuffIt.segmenting.segment
  1455. StuffIt.segmenting.segmentInPlace
  1456. StuffIt.segmenting.segmentInPlaceWithSize
  1457. StuffIt.segmenting.joinInPlace
  1458.  
  1459. Verb    StuffIt.segmenting.joinInPlace
  1460. Syntax    StuffIt.segmenting.joinInPlace (pathname)
  1461. Parameters    pathname: the filenames of the items you wish to join (wildcards are accepted)
  1462. Action    Joins the files you specify into one file
  1463. Returns    true if the files were joined, false if they were not
  1464. Examples    StuffIt.segmenting.joinInPlace ("My HD:My Folder:My segments")
  1465.     »true (the files were joined)
  1466. Notes    This verb differs from join in that you cannot specify how to deal with potential problems. In join you can specify whether or not to replace files with the same name or to notify the user if a problem shows up.
  1467. With this verb, these two parameters default to false. No files will get overwritten and the user will not be alerted should an error arise
  1468. See Also    StuffIt.segmenting.segment
  1469. StuffIt.segmenting.segmentInPlace
  1470. StuffIt.segmenting.segmentInPlaceWithSize
  1471. StuffIt.segmenting.join
  1472.  
  1473. Verb    StuffIt.segmenting.segment
  1474. Syntax    StuffIt.segmenting.segment (pathname, replace, prompt, size)
  1475. Parameters    pathname: the pathnames of the files you wish to segment (Wild cards may be used)
  1476. replace: true or false, whether or not to replace any files which have the same names
  1477. prompt: true or false, whether or not to prompt the user should there be any problems
  1478. size: the number of K you wish each segment to be (0 is maximum)
  1479. Action    Segments the files you specify into fragments of sizes which you specify
  1480. Returns    true or false, depending on the success
  1481. Examples    StuffIt.segment ("My HD:My Folder:My Files",true,false,800)
  1482.     »true (My Files were segmented, replacing any files which had the same name, into blocks of 800 K each)
  1483. See Also    StuffIt.segmenting.join
  1484. StuffIt.segmenting.joinInPlace
  1485. StuffIt.segmenting.segmentInPlace
  1486. StuffIt.segmenting.segmentInPlacewithsize
  1487.  
  1488. Verb    StuffIt.segmenting.segmentInPlace
  1489. Syntax    StuffIt.segmenting.segmentInPlace (pathname)
  1490. Parameters    pathname: the pathnames of the files you wish to segment (Wild cards may be used)
  1491. Action    Segments the files you specify, without replacing any files and without prompting you if there is an error
  1492. Returns    true or false, depending on the success of the segmenting
  1493. Examples    StuffIt.segmenting.segmentInPlace ("My HD:My Folder:My Files")
  1494.     »true (My Files were segmented)
  1495. Notes    This verb is different from segment in that you have more control with segment. With this verb, all the parameters revert to their defaults
  1496. The default of whether or not to replace files with the same name is false, as is the default of whether or not to prompt the user when an error occurs.
  1497. The default size is set at the user's default, which is set within StuffIt. If no default has been set, StuffIt uses the last size which was used.
  1498. See Also    StuffIt.segmenting.join
  1499. StuffIt.segmenting.joinInPlace
  1500. StuffIt.segmenting.segment
  1501. StuffIt.segmenting.segmentInPlacewithsize
  1502.  
  1503. Verb    StuffIt.segmenting.segmentInPlaceWithSize
  1504. Syntax    StuffIt.segmenting.segmentInPlaceWithSize (pathname, size)
  1505. Parameters    pathname: the pathnames of the files you wish to segment (Wild cards may be used)
  1506. size: the maximum size (in K) you wish each segment to be
  1507. Action    Segments the files you specify into segments, without replacing any files and without prompting you if there is an error, but allowing you to specify a size
  1508. Returns    true or false, depending on the success of the segmenting
  1509. Examples    StuffIt.segmenting.segmentInPlaceWithSize ("My HD:My Folder:My Files",800)
  1510.     »true (My Files were segmented into 800K files)
  1511. Notes    This verb is different from segment in that you have more control with segment. With this verb, most of the optional parameters revert to their defaults
  1512. The default of whether or not to replace files with the same name is false, as is the default of whether or not to prompt the user when an error occurs.
  1513. See Also    StuffIt.segmenting.join
  1514. StuffIt.segmenting.joinInPlace
  1515. StuffIt.segmenting.segment
  1516. StuffIt.segmenting.segmentInPlace
  1517.  
  1518. Verb    StuffIt.selection.addAll
  1519. Syntax    StuffIt.selection.addAll ()
  1520. Parameters    None
  1521. Action    Selects all the items in the current level of the current archive
  1522. Returns    0 if there was no error
  1523. -1 if no archive is open
  1524. Examples    StuffIt.selection.addAll ()
  1525.     »0 (all the items on the current level are now hilited)
  1526. See Also    StuffIt.selection.clearAll
  1527.  
  1528. Verb    StuffIt.selection.addbyPattern
  1529. Syntax    StuffIt.selection.addbyPattern (pattern)
  1530. Parameters    pattern: the text which StuffIt uses to select names.  Usually this is a wildcard specifier.
  1531. Action    Selects all the items in the current level of the current archive whose names include pattern
  1532. Returns    0 if there was no error
  1533. -1 if no archive is open
  1534. Examples    StuffIt.selection.addByPattern ("Ki*")
  1535.     »0 (all the items on the current level which start with Ki are now hilited)
  1536. Notes    Wild card characters may be used. They are as follows:
  1537. ? = matches any letter
  1538. * = matches one or more letters
  1539. \* = * (the real character, not the code)
  1540. \? = ? (the real character, not the code)
  1541. \\=\ (the real character, not the code)
  1542. So, to select all files which begin with Te and end with xt, you would use Te*xt
  1543. See Also    StuffIt.selection.AddTo
  1544. StuffIt.selection.removeFrom
  1545. StuffIt.selection.addAll
  1546. StuffIt.selection.clearAll
  1547.  
  1548. Verb    StuffIt.selection.addTo
  1549. Syntax    StuffIt.selection.addTo (ID)
  1550. Parameters    ID: The offset in the archive of the item you wish to rename. This offset is based on a propietary numbering scheme in StuffIt, so there's no way to set it.
  1551. Action    Adds the item you specify to the current selection
  1552. Returns    0 if there was no error
  1553. -1 if no archive is open
  1554. Examples    StuffIt.selection.addTo (StuffIt.getFirstItem())
  1555.     »0 (the first item in the archive was added to the selection)
  1556. See Also    StuffIt.selection.addAll
  1557. StuffIt.selection.clearAll
  1558. StuffIt.selection.removeFrom
  1559.  
  1560. Verb    StuffIt.selection.clearAll
  1561. Syntax    StuffIt.selection.clearAll ()
  1562. Parameters    None
  1563. Action    Unselects all the items in the current level of the current archive
  1564. Returns    0 if there was no error
  1565. -1 if no archive is open
  1566. Examples    StuffIt.selection.clearAll ()
  1567.     »0 (none of the items on the current level are now hilited)
  1568. See Also    StuffIt.selection.addAll
  1569. StuffIt.selection.removeFrom
  1570. StuffIt.selection.addTo
  1571. StuffIt.selection.addbyPattern
  1572.  
  1573. Verb    StuffIt.selection.delete
  1574. Syntax    StuffIt.selection.delete ()
  1575. Parameters    None
  1576. Action    Deletes the selection, without a warning dialog box
  1577. Returns    0 if there was no error
  1578. -1 if no archive is open
  1579. -8 if the archive is read-only
  1580. Examples    StuffIt.selection.delete ()
  1581.     »0 (all the items that were selected have been deleted)
  1582. See Also    StuffIt.selection.addAll
  1583. StuffIt.selection.addTo
  1584. StuffIt.selection.addByPattern
  1585. StuffIt.selection.removeFrom
  1586.  
  1587. Verb    StuffIt.selection.getCount
  1588. Syntax    StuffIt.selection.getCount ()
  1589. Parameters    None
  1590. Action    Returns the number of items which are selected
  1591. Returns    the number of selected items
  1592. -1 if no archive is open
  1593. Examples    StuffIt.selection.getCount ()
  1594.     »3 (three items are selected on the current level)
  1595. See Also    StuffIt.selection.addAll
  1596. StuffIt.selection.clearAll
  1597. StuffIt.selection.removeFrom
  1598. StuffIt.selection.addTo
  1599. StuffIt.selection.addbyPattern
  1600.  
  1601. Verb    StuffIt.selection.getID
  1602. Syntax    StuffIt.selection.getID (index)
  1603. Parameters    index: a number, from 1 on, which represents the item within the selection whose offset you want.
  1604. For example, the second selected item would have an index of 2
  1605. Action    Returns the offset of the item you specify with index
  1606. Returns    the offset of the specified item
  1607. -1 if no archive is open
  1608. -2 if the index you used is out of range
  1609. Examples    StuffIt.selection.getID (1)
  1610.     »22 (the offset of the first selected item)
  1611. See Also    StuffIt.selection.addAll
  1612. StuffIt.selection.clearAll
  1613. StuffIt.selection.removeFrom
  1614. StuffIt.selection.addTo
  1615. StuffIt.selection.addbyPattern
  1616.  
  1617. Verb    StuffIt.selection.removeFrom
  1618. Syntax    StuffIt.selection.removeFrom (ID)
  1619. Parameters    ID: The offset of the file information within the archive. Based on a propietary numbering scheme used by StuffIt Deluxe.
  1620. Action    Removes the item you specify from the selection
  1621. Returns    0 if no error occurred
  1622. 1 if the item you specified is not at the current level
  1623. -1 if no archive is open
  1624. -2 if the offset you used is out of range
  1625. -5 if you specified an end-of-folder marker
  1626. -6 if you specified the root of the archive (0)
  1627. Examples    StuffIt.selection.removeFrom (StuffIt.selection.getID(1))
  1628.     »0 (the first selected item was de-selected)
  1629. See Also    StuffIt.selection.addAll
  1630. StuffIt.selection.clearAll
  1631. StuffIt.selection.addTo
  1632. StuffIt.selection.addbyPattern
  1633. StuffIt.selection.getID
  1634.  
  1635. Verb    StuffIt.selection.rename
  1636. Syntax    StuffIt.selection.rename (newName)
  1637. Parameters    newName: the new name you would like to assign to the selections
  1638. Action    Renames all the selected items to newName
  1639. Returns    0 if no error occurred
  1640. -1 if no archive is open
  1641. -2 if no files were selected
  1642. -8 if current archive is read-only
  1643. Examples    StuffIt.selection.rename ("Cool Things")
  1644.     »0 (all the selected items were renamed to Cool Things)
  1645. See Also    StuffIt.selection.addAll
  1646. StuffIt.selection.clearAll
  1647. StuffIt.selection.removeFrom
  1648. StuffIt.selection.addTo
  1649. StuffIt.selection.addbyPattern
  1650.  
  1651. Verb    StuffIt.selection.unStuff
  1652. Syntax    StuffIt.selection.unStuff (path)
  1653. Parameters    path - full pathname to the location you want the selected items unstuffed to
  1654. Action    UnStuffs all the selected items
  1655. Returns    0 if there was no error
  1656. -1 if no archive is open
  1657. -2 no items selected
  1658. 4 integrity error in header -- cannot continue
  1659. 5 integrity error in file -- may be corrupt
  1660. Other negative numbers are OS errors
  1661. Examples    StuffIt.selection.unStuff ("My HD:")
  1662.     »0 (all selected items are unstuffed to the root of my hard disk)
  1663. See Also    StuffIt.unStuffItem
  1664. StuffIt.unStuffInPlace
  1665. StuffIt.selection.addAll
  1666. StuffIt.selection.removeFrom
  1667. StuffIt.selection.addTo
  1668. StuffIt.selection.addbyPattern
  1669.  
  1670. Verb    StuffIt.selection.view
  1671. Syntax    StuffIt.selection.view ()
  1672. Parameters    None
  1673. Action    Views all the selected items
  1674. Returns    0 if no error occurred
  1675. -1 if no archive is open
  1676. -2 if no files were selected
  1677. Examples    StuffIt.selection.view ()
  1678.     »0 (all TEXT and PICT files have been opened for me to view)
  1679. Notes    This verb is only available for StuffIt Deluxe, since StuffIt Lite does not support Viewers.
  1680. See Also    StuffIt.selection.addAll
  1681. StuffIt.selection.clearAll
  1682. StuffIt.selection.removeFrom
  1683. StuffIt.selection.addTo
  1684. StuffIt.selection.addbyPattern
  1685.  
  1686. Verb    StuffIt.setCurrentArchive
  1687. Syntax    StuffIt.setCurrentArchive (path)
  1688. Parameters    path: the full pathname of the archive you wish to make the current archive
  1689. Action    Brings the archive you specify to the front, making it the current archive
  1690. Returns    0 if there was no error
  1691. -1 if no such archive is open
  1692. Examples    StuffIt.setCurrentArchive ("My HD:My Folder:My StuffIt File")
  1693.     »0 (My StuffIt File was open and is now the current archive)
  1694. See Also    StuffIt.openArchive
  1695. StuffIt.closeArchive
  1696. StuffIt.getCurrentArchivePath
  1697.  
  1698. Verb    StuffIt.stuffInPlace
  1699. Syntax    StuffIt.stuffInPlace (path)
  1700. Parameters    path: the pathname of the file or folder you'd like to stuff 
  1701. Action    Takes the folder/file you specify and stuffs in into a new archive at the same location.
  1702. Returns    0 if there was no error
  1703. Other negative numbers are OS Errors
  1704. Examples    StuffIt.stuffInPlace ("My HD:My Folder:My File")
  1705.     »0 (My File was stuffed into "My File.sit" in "My HD:My Folder:")
  1706. See Also    StuffIt.stuffItem
  1707. StuffIt.unstuffInPlace
  1708.  
  1709. Verb    StuffIt.stuffItem
  1710. Syntax    StuffIt.stuffItem (path)
  1711. Parameters    path: the pathname of the file or folder you'd like to stuff  into the current archive
  1712. Action    Takes the folder/file you specify and adds it to the current level of the frontmost archive.
  1713. Returns    0 if there was no error
  1714. -1 if no archive is currently open
  1715. -7 if there are already too many items in the archive
  1716. -8 if the frontmost archive is read-only
  1717. Examples    StuffIt.stuffItem ("My HD:My Folder:My File")
  1718.     »0 (My File was added to the current level of the archive)
  1719. See Also    StuffIt.encryptItem
  1720. StuffIt.stuffInPlace
  1721. StuffIt.unstuffItem
  1722.  
  1723. Verb    StuffIt.translate.translate
  1724. Syntax    StuffIt.translate (translator,script)
  1725. Parameters    translator: the translator you wish to use
  1726. script: the translator script you wish processed
  1727. Action    Translates the file you specify with the translator of your choice
  1728. Returns    true or false, depending on the success of the translation
  1729. Examples    StuffIt.translate ("CompactPro Translator","Decode “My HD:My Folder:My CompactPro document”")
  1730.     »true (my CompactPro documents were successfully translated)
  1731. Notes    This is a "low level" verb, and should be used only if you need greater control or flexibility.
  1732. Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1733. See Also    StuffIt.translate.decode
  1734. StuffIt.translate.decodeTo
  1735. StuffIt.translate.encode
  1736. StuffIt.translate.encodeTo
  1737.  
  1738. Verb    StuffIt.translate.decode
  1739. Syntax    StuffIt.translate.decode (translator,pathname)
  1740. Parameters    translator: the translator you wish to use
  1741. pathname: the file you wish to translate
  1742. Action    Translates the file you specify with the translator of your choice
  1743. Returns    true or false, depending on the success of the translation
  1744. Examples    StuffIt.translate.decode ("CompactPro Translator","My HD:My Folder:My CompactPro document")
  1745.     »true (my CompactPro documents were successfully translated)
  1746. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1747. The decoded/expanded file is put at the same level as the original.
  1748. See Also    StuffIt.translate.decodeTo
  1749. StuffIt.translate.encode
  1750. StuffIt.translate.encodeTo
  1751.  
  1752. Verb    StuffIt.translate.decodeTo
  1753. Syntax    StuffIt.translate.decodeTo (translator,sourcePath,destPath)
  1754. Parameters    translator: the translator you wish to use
  1755. sourcePath: the pathname of the file you wish to translate
  1756. destPath: the pathname where you want the translated file
  1757. Action    Translates the file you specify with the translator of your choice, and to the place you specify
  1758. Returns    true or false, depending on the success of the translation
  1759. Examples    StuffIt.translate.decodeTo ("CompactPro Translator","My HD:My Folder:My CompactPro document","My HD:My Folder:My Expanded Files")
  1760.     »true (my CompactPro documents were successfully translated to My Expanded Files)
  1761. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1762. See Also    StuffIt.translate.decode
  1763. StuffIt.translate.encode
  1764. StuffIt.translate.encodeTo
  1765.  
  1766. Verb    StuffIt.translate.encode
  1767. Syntax    StuffIt.translate.encode (translator,sourcePath)
  1768. Parameters    translator: the translator you wish to use
  1769. sourcePath: the pathname of the file you wish to encode with a translator
  1770. Action    Translates the StuffIt archive you specify into the format you specify.
  1771. Returns    true or false, depending on the success of the translation
  1772. Examples    StuffIt.translate.encode ("BinHex4","My HD:My Folder:My File")
  1773.     »true (the file was translated into a BinHex4 document)
  1774. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1775. The new file will be placed in the same location as the original.
  1776. See Also    StuffIt.translate.decode
  1777. StuffIt.translate.decodeTo
  1778. StuffIt.translate.encodeTo
  1779.  
  1780. Verb    StuffIt.translate.encodeTo
  1781. Syntax    StuffIt.translate.encodeTo (translator,sourcePath,destPath)
  1782. Parameters    translator: the translator you wish to use
  1783. sourcePath: the pathname of the file you wish to translate
  1784. destPath: the pathname where you want to place the translated file
  1785. Action    Encodes the file you specify with the translator of your choice, and to the place you specify
  1786. Returns    true or false, depending on the success of the encoding
  1787. Examples    StuffIt.translate.encodeTo ("BinHex4","My HD:My Folder:My File","My HD:My Folder:My BinHex document")
  1788.     »true (the archive were successfully translated into BinHex4 documents)
  1789. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1790. See Also    StuffIt.translate.decode
  1791. StuffIt.translate.decodeTo
  1792. StuffIt.translate.encode
  1793.  
  1794. Verb    StuffIt.unStuffInPlace
  1795. Syntax    StuffIt.unStuffInPlace (path)
  1796. Parameters    path: the full pathname of the archive you wished unstuffed
  1797. Action    Unstuffs the contents of the archive into the same folder as the archive
  1798. Returns    0 if there was no error
  1799. Other negative numbers are OS errors
  1800. Examples    StuffIt.unStuffInPlace ("My HD:My Folder:My Archive.sit")
  1801.     »0 (Unstuffs "My Archive.sit" into "My HD:My Folder")
  1802. See Also    Stuffit.unStuffItem
  1803. StuffIt.stuffInPlace
  1804. StuffIt.stuffItem
  1805.  
  1806. Verb    StuffIt.unStuffItem
  1807. Syntax    StuffIt.unStuffItem (ID,path)
  1808. Parameters    ID: The offset in the archive of the item you wish to rename. This offset is based on a propietary numbering scheme in StuffIt, so there's no way to set it.
  1809. path: the full pathname of the destination for the unstuffed files
  1810. Action    Unstuffs the item you specify into the pathname you specify
  1811. Returns    0 if there was no error
  1812. -1 if no archive is open
  1813. -2 if the offset you specify is out of range
  1814. -5 if the offset you specified is an end-of-folder
  1815. Other negative numbers are OS errors
  1816. Examples    StuffIt.unStuffItem (StuffIt.getFirstItem(), "My HD:My Folder:My Unstuffed File")
  1817.     »0 (Unstuffs the first item in the archive to My Unstuffed File)
  1818. See Also    StuffIt.stuffItem
  1819. StuffIt.unStuffInPlace
  1820. StuffIt.stuffInPlace
  1821.  
  1822. Verb    StuffIt.verifyArchive
  1823. Syntax    StuffIt.verifyArchive ()
  1824. Parameters    None
  1825. Action    Verifies the frontmost archive
  1826. Returns    true if the archive was successfully verified
  1827. Examples    StuffIt.verifyArchive ()
  1828.     »true (the archive was verified successfully)
  1829. Notes    Since the verb returns only true or false, you will need to check the situation if you get false. For instance, this may mean that the archive is corrupted, or it may mean that no archive is currently open.
  1830.  
  1831. Verb    StuffIt.visitArchive
  1832. Syntax    StuffIt.visitArchive (levels,callback)
  1833. Parameters    levels: the amount of levels down in the archive you wish to go
  1834. callback: the script you want performed at each item in the archive
  1835. Action    "Visits" the frontmost archive. This verb is very similar to the visit object verbs in Frontier. You specify how many levels down you wish the script to go. At each item in those levels, the callback script will be executed. 
  1836. Returns    varies on what you've set your callback script to do
  1837. Examples    StuffIt.visitArchive (2, people.dfs.utilityScripts.StuffItCallBackScript ())
  1838.     »results may vary (if your callback script returns a value, for instance)
  1839.